<!DOCTYPE html>
<html lang="en">
<head>
    
    <meta charset="utf-8">
    <title>Home - Zero UI框架专用前端文档</title>
    
    <meta name="description" content="前端开发框架，官方地址：http://www.vertx-ui.cn" />
    
        <meta name="keywords" content="zero,zero-ui,vert.x" />
        <meta name="keyword" content="zero,zero-ui,vert.x" />
    
    
    
    <script src="scripts/prettify/prettify.js"></script>
    <script src="scripts/prettify/lang-css.js"></script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
    <link type="text/css" rel="stylesheet" href="styles/zero.css">
    <script src="scripts/nav.js" defer></script>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>

<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
  <div class="navicon"></div>
</label>

<label for="nav-trigger" class="overlay"></label>

<nav >
    
    <input type="text" id="nav-search" placeholder="Search" />
    
    <h2><a href="index.html">Home</a></h2><h2><a href="http://www.vertxai.cn/document/doc-web/index.html" target="_blank" class="menu-item" id="website_link" >「Api」Zero Ai</a></h2><h2><a href="http://www.vertxui.cn/document/doc-web/index.html" target="_blank" class="menu-item" id="website_link" >「Api」Zero Ui</a></h2><h2><a href="http://www.vertxui.cn/document/doc-web-extension/index.html" target="_blank" class="menu-item" id="website_link" >「Api」Zero Ui Extension</a></h2><h2><a href="http://www.vertxui.cn" target="_blank" class="menu-item" id="website_link" >「Home」Zero UI</a></h2><h2><a href="http://www.vertxai.cn" target="_blank" class="menu-item" id="website_link" >「Home」Zero Ai</a></h2><h2><a href="http://www.vertxup.cn" target="_blank" class="menu-item" id="website_link" >「Home」Zero Framework</a></h2><h2><a href="http://www.origin-x.cn" target="_blank" class="menu-item" id="website_link" >「Home」Origin X Engine</a></h2><h3>Classes</h3><ul><li><a href="E.html">E</a></li></ul><h3>Modules</h3><ul><li><a href="module-__epic.html">__epic</a></li><li><a href="module-ai.html">ai</a><ul class='methods'><li data-type='method'><a href="module-ai.html#.csv">csv</a></li><li data-type='method'><a href="module-ai.html#.data">data</a></li><li data-type='method'><a href="module-ai.html#.init">init</a></li><li data-type='method'><a href="module-ai.html#.key">key</a></li><li data-type='method'><a href="module-ai.html#.md5">md5</a></li><li data-type='method'><a href="module-ai.html#.str">str</a></li><li data-type='method'><a href="module-ai.html#.sync">sync</a></li><li data-type='method'><a href="module-ai.html#.uk">uk</a></li><li data-type='method'><a href="module-ai.html#.uuid">uuid</a></li></ul></li><li><a href="module-aj.html">aj</a><ul class='methods'><li data-type='method'><a href="module-aj.html#.bundle">bundle</a></li><li data-type='method'><a href="module-aj.html#.init">init</a></li><li data-type='method'><a href="module-aj.html#.mod">mod</a></li><li data-type='method'><a href="module-aj.html#.perm">perm</a></li><li data-type='method'><a href="module-aj.html#.plugin">plugin</a></li><li data-type='method'><a href="module-aj.html#.rs">rs</a></li></ul></li><li><a href="module-art.html">art</a><ul class='methods'><li data-type='method'><a href="module-art.html#.complex">complex</a></li><li data-type='method'><a href="module-art.html#.form">form</a></li></ul></li></ul>
</nav>

<div id="main">
    

    



    


    <section class="package">
        <h3> </h3>		
    </section>









    











<section>

<header>
    
        <h2>
        epic/index.js
        </h2>
        
    
</header>

<article>
    
        <div class="container-overview">
        
            

<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




            
                <div class="description usertext"><h1>Zero Ai研发文档</h1>
<p>该文档提供给研发人员直接研发下列工具专用，最新版本<code>0.3.30</code>。</p>
<h2>1. 命令清单</h2>
<ul>
<li><code>ai xxx</code>：通用自动化工具集。</li>
<li><code>aj xxx</code>：后端自动化工具集（ai for java）。</li>
<li><code>art xxx</code>：前端自动化工具集（ai for react）。</li>
</ul>
<h2>2. Epic使用方法</h2>
<blockquote>
<p>Epic是内部研发专用工具，位于API文档中有相关说明，记录了当前环境下用于内部研发的所有工具集，命令教程中的顺序按开发配置中的顺序进行，开发配置目录位于：<code>src/commander</code> 中。</p>
</blockquote>
<pre class="prettyprint source lang-js"><code>const Ec = require('./epic');
// Ec.xxx 调用全程Api
</code></pre>
<h2>3. 文档结构</h2>
<ol>
<li>所有API文档结构分为四个部分：
<ul>
<li><code>__epic</code>：研发专用工具集，属于内部工具集（改造命令时专用）</li>
<li><code>ai</code>：通用工具命令</li>
<li><code>aj</code>：后端自动化工具集</li>
<li><code>art</code>：前端自动化工具集</li>
</ul>
</li>
<li>和执行命令相关的错误信息全部位类 <code>E</code> 中有所定义。</li>
</ol>
<h2>4. 工具研发</h2>
<h3>4.1. 源码</h3>
<p>工具研发源代码位于 <code>src</code> 目录中，子目录详细信息如下：</p>
<table>
<thead>
<tr>
<th>目录</th>
<th style="text-align:left">含义</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>cab</code></td>
<td style="text-align:left">代码模板、文档模板、资源文件模板。</td>
</tr>
<tr>
<td><code>commander</code></td>
<td style="text-align:left">命令定义文件，包括<code>ai/aj/art</code>三个命令的定义。</td>
</tr>
<tr>
<td><code>commander-ai</code></td>
<td style="text-align:left">开发 <code>ai xxx</code> 命令专用目录。</td>
</tr>
<tr>
<td><code>commander-aj</code></td>
<td style="text-align:left">开发 <code>aj xxx</code> 命令专用目录。</td>
</tr>
<tr>
<td><code>commander-ar</code></td>
<td style="text-align:left">开发 <code>art xxx</code> 命令专用目录。</td>
</tr>
<tr>
<td><code>epic</code></td>
<td style="text-align:left">内部研发专用工具集。</td>
</tr>
</tbody>
</table>
<h3>4.2. 参数表</h3>
<p>参数表定义位于 <code>src/commander/option.zero</code> 文件中，只有此文件中的参数是可用参数，形成统一的 <strong>参数规范</strong>。命令执行时并非支持所有命令，参数表中会有命令中所使用的参数列表，只是所有命令中这些参数的 <strong>缩写和全称</strong> 维持一致，在不同命令中表示相同或相近的含义。</p>
<table>
<thead>
<tr>
<th style="text-align:left">简写</th>
<th style="text-align:left">全称</th>
<th style="text-align:left">含义</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>-f</code></td>
<td style="text-align:left"><code>--field</code></td>
<td style="text-align:left">一般表示字段名称，用于描述模型字段、文件列等各种字段信息。</td>
</tr>
<tr>
<td style="text-align:left"><code>-d</code></td>
<td style="text-align:left"><code>--data</code></td>
<td style="text-align:left">用于表示数据文件位置，或数据内容指向。</td>
</tr>
<tr>
<td style="text-align:left"><code>-p</code></td>
<td style="text-align:left"><code>--path</code></td>
<td style="text-align:left">指定文件路径专用参数，用来描述输入文件路径。</td>
</tr>
<tr>
<td style="text-align:left"><code>-c</code></td>
<td style="text-align:left"><code>--config</code></td>
<td style="text-align:left">用于表示配置文件位置，或配置内容指向。</td>
</tr>
<tr>
<td style="text-align:left"><code>-j</code></td>
<td style="text-align:left"><code>--json</code></td>
<td style="text-align:left">用于表示JSON的格式或基于 Json Schema 的数据格式描述。</td>
</tr>
<tr>
<td style="text-align:left"><code>-n</code></td>
<td style="text-align:left"><code>--number</code></td>
<td style="text-align:left">用于指定数量信息，通常在生成数据时表示生成数据条数。</td>
</tr>
<tr>
<td style="text-align:left"><code>-o</code></td>
<td style="text-align:left"><code>--out</code></td>
<td style="text-align:left">用于指定输出文件位置，通常是生成代码输出目录、输出文件描述。</td>
</tr>
<tr>
<td style="text-align:left"><code>-k</code></td>
<td style="text-align:left"><code>--key</code></td>
<td style="text-align:left">表示键名，用于描述模型键、文件列唯一键、数据表主键等信息。</td>
</tr>
<tr>
<td style="text-align:left"><code>-u</code></td>
<td style="text-align:left"><code>--ui</code></td>
<td style="text-align:left">前端界面专用生成参数，可以是目录也可以是内容等各种用来描述前端配置路径的专用参数。</td>
</tr>
<tr>
<td style="text-align:left"><code>-t</code></td>
<td style="text-align:left"><code>--target</code></td>
<td style="text-align:left">用于描述目标对象，此参数不局限于输出模式，通常可以表示目标信息描述。</td>
</tr>
<tr>
<td style="text-align:left"><code>-s</code></td>
<td style="text-align:left"><code>--separator</code></td>
<td style="text-align:left">用于表示分隔符信息，如果是处理文件，此属性默认会提取操作系统分隔符。</td>
</tr>
<tr>
<td style="text-align:left"><code>-m</code></td>
<td style="text-align:left"><code>--module</code></td>
<td style="text-align:left">用于描述模块，通常表示模块名称、模块元数据定义。</td>
</tr>
<tr>
<td style="text-align:left"><code>-a</code></td>
<td style="text-align:left"><code>--all</code></td>
<td style="text-align:left">开启全格式、全逻辑、全流程的专用选项。</td>
</tr>
<tr>
<td style="text-align:left"><code>-y</code></td>
<td style="text-align:left"><code>--yes</code></td>
<td style="text-align:left">确认选项专用参数，通常用于指定布尔开关时会使用此参数。</td>
</tr>
<tr>
<td style="text-align:left"><code>-v</code></td>
<td style="text-align:left"><code>--value</code></td>
<td style="text-align:left">用于描述值相关信息，如字符串值、数值、布尔值等相关值信息，某些场合用来描述值字段。</td>
</tr>
<tr>
<td style="text-align:left"><code>-r</code></td>
<td style="text-align:left"><code>--role</code></td>
<td style="text-align:left">在权限管理模型中，用于描述角色信息，通常在权限执行时专用。</td>
</tr>
<tr>
<td style="text-align:left"><code>-i</code></td>
<td style="text-align:left"><code>--input</code></td>
<td style="text-align:left">用于指定输入文件位置，或输入目录、输入内容描述。</td>
</tr>
<tr>
<td style="text-align:left"><code>-l</code></td>
<td style="text-align:left"><code>--length</code></td>
<td style="text-align:left">用于指定长度信息，通常在密码处理时用于描述生成字符串的长度。</td>
</tr>
<tr>
<td style="text-align:left"><code>-e</code></td>
<td style="text-align:left"><code>--extension</code></td>
<td style="text-align:left">用于指定扩展名、扩展等相关信息。</td>
</tr>
<tr>
<td style="text-align:left"><code>-w</code></td>
<td style="text-align:left"><code>--write</code></td>
<td style="text-align:left">用于写入操作的专用描述，通常生成文件时会使用此参数。</td>
</tr>
</tbody>
</table></div>
            

            
        
        </div>
    

    

    

    
    
    

     

    

    

    

    

    
</article>

</section>




    
    
</div>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Sun Jul 23 2023 12:31:31 GMT+0800 (China Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
<script src="scripts/polyfill.js"></script>
<script src="scripts/linenumber.js"></script>

<script src="scripts/search.js" defer></script>



</body>
</html>